[]
        
(Showing Draft Content)

dashboard.VisualNS.FormatService

类: FormatService

dashboard.VisualNS.FormatService

Table of contents

构造方法

方法

构造方法

constructor

new FormatService()

方法

format

format(format, value, displayUnit?): string

格式化一个值。

参数

名称 类型 描述
format string 该参数来自Format属性,或DataView Profile项
value string | number | boolean | Date 将被格式化的值
displayUnit? DisplayUnit 仅用于数字,默认displayUnit为DisplayUnit.None。

返回值

string

示例代码

const formatService = this.visualHost.formatService;
const { displayUnit, labelFormat } = updateOptions.properties;
let realDisplayUnit = displayUnit;
if (formatService.isAutoDisplayUnit(displayUnit)) {
   const values = dataPoints.map(dataPoint => dataPoint.value);
   realDisplayUnit = formatService.getAutoDisplayUnit(values);
}
dataPoints.forEach((dataPoint) => {
   //为标签设置一个格式化的值。
   dataPoint.labelText = formatService.format(labelFormat, dataPoint.value, realDisplayUnit);
})

getAutoDisplayUnit

getAutoDisplayUnit(values): DisplayUnit

当数据单位设置为“自动”时,根据传入的数值计算出真正的数据单位。

参数

名称 类型
values number[]

返回值

DisplayUnit


isAutoDisplayUnit

isAutoDisplayUnit(displayUnit): boolean

返回一个布尔值,指示数据单位是否为 “自动”。

参数

名称 类型
displayUnit DisplayUnit

返回值

boolean